Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #185

Open
wants to merge 229 commits into
base: master
Choose a base branch
from
Open

Improve documentation #185

wants to merge 229 commits into from

Conversation

cebtenzzre
Copy link
Collaborator

I've tried to improve the documentation somewhat, with the primary goal of having less new issues about things like youtube-dl, Python, and SSL errors. I renumbered some headings (as much as I like 0-based indexing) and removed some information that I found unnecessary and/or outdated.

For now I've left the beginner's guide alone, given the existing PR(s).

@cebtenzzre
Copy link
Collaborator Author

A command to check if you already have the python2 module should probably be added to the docs. It should better explain that you may already have the python3 module as part of youtube-dl, but that tumblr-utils cannot use it.
Until those get added, don't merge this yet.

@cebtenzzre
Copy link
Collaborator Author

@bbolli I rebased and cleaned up this PR. Is it good to merge or should I close it?

On many systems, python refers to Python 3.
Certain options should never be negative, and a count of zero should
actually download zero posts, not all of them. Also, make sure we can
read cookiefile before we back up any blogs.

Included revisions:
- Add check for confusing -i -n 0
Posts are now read from disk each time they are needed, instead of
keeping them all in memory.

This is especially needed when --save-notes is used with a large blog,
as this often results in many gigabytes worth of HTML that does not fit
into free memory all at once.
qsize() acquires a mutex on the queue, which is shared between threads.
Read it only once to avoid a race condition.
Included revisions:
- Make typing optional
Included revisions:
- Saner non-option arguments
Included revisions:
- Remove log_queue, better status and account logic
- Better tracking and synchronization on ThreadPool.queue.qsize
- Remove remaining_posts
- Remove getting_tup
- Put back the account parameter

Fixes bbolli#169
Behaves similar to cp -u or or rsync when copying local files into the
media directory.

Included revisions:
- Use prev_archive for style.css
Store the original exception instead of trying to reconstruct it later.
The reference cycle can be avoided with traceback.clear_frames.

Closes #12
- required dependencies are now assumed instead of using hacky fallbacks
- optional dependencies are now listed in pyproject.toml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant